home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sfguess.zip / SFGUESS.DOC next >
Text File  |  1990-06-08  |  14KB  |  293 lines
  1.                                 SFGUESS.EXE
  2.                                 Version 2.0
  3.                   Guess A Number SPITFIRE Demostration Game   
  4.                             Written by Mike Woltz
  5.                            Buffalo Creek Software
  6.                              All Rights Reserved
  7.                              
  8.  
  9.         INTRODUCTION
  10.         ------------
  11.  
  12.         SFGUESS is a complimentary SPITFIRE program which can be used as
  13.         either a door program set up and run from the SF.BAT file or as one
  14.         of the optional SPITFIRE sysop configurable commands available from
  15.         the Main, Message or File Menu.  SFGUESS is included in your SPITFIRE
  16.         Bulletin Board System package.  SFGUESS can be played on your BBS
  17.         once is has been set up to run as a SPITFIRE Door Program or through
  18.         the SFMAIN.BAT, SFMESS.BAT or SFFILE.BAT files as a sysop configureable
  19.         command from the corresponding menu.
  20.         
  21.  
  22.  
  23.         SFGUESS SET UP PROCEDURE AS A DOOR
  24.         ----------------------------------
  25.         
  26.         The following example assumes that you do not have any doors presently
  27.         setup.  It also assumes that you are running SPITFIRE on drive C in 
  28.         a directory named SF.  In the event you are running SPITFIRE on a 
  29.         different drive and/or in a different directory than C:\SF, then the 
  30.         SF.BAT file example (list below) will have to be altered to reflect 
  31.         the correct drive and directories.
  32.         
  33.              Let's configure your first door now, step by step.  The first
  34.         thing to do is create a file named SFDOOR.MNU, using your favorite
  35.         text editor.  Place it in your system files directory.  Keep in mind 
  36.         SPITFIRE supports 8 doors so your SFDOOR.MNU file can have a maximum
  37.         of 8 lines.  Since we are configuring door #1, SFDOOR.MNU will have
  38.         only 1 line.  For demonstration purposes, let's write the line to
  39.         look like this:
  40.  
  41.         Guess A Number,10
  42.         
  43.              The name of the door (as you'll have it appear in the Door Menu)
  44.         comes first in the line.  You then enter a comma, which is used to
  45.         tell SPITFIRE where to end the name of the door and where to start
  46.         reading the security level of the door.  In the above example, the name
  47.         of the door is "Guess A Number" and it requires a security level of 10
  48.         for a caller to be able to use it.
  49.         
  50.              Next, create a sub-directory of your SF directory named DOOR1 and
  51.         move the SFGUESS.EXE file into your DOOR1 directory.  Consult your DOS
  52.         manual if you do not understand how to create directories.
  53.  
  54.              Now load your SF.BAT file into your favorite text editor and find
  55.         a line that reads :DOOR_1.  You will place your door #1 commands (valid
  56.         DOS commands, program execution, etc.) between :DOOR_1 and GOTO LOOP.
  57.         That portion of your SF.BAT file should be changed to read as listed
  58.         below:
  59.         
  60.         :DOOR_1
  61.         COPY SFDOORS.DAT C:\SF\DOOR1
  62.         CD\SF\DOOR1
  63.         SFGUESS
  64.         ERASE SFDOORS.DAT
  65.         CD\SF
  66.         GOTO LOOP
  67.         :DOOR_2
  68.                                                             
  69.  
  70.              Once you have saved the changes in your SF.BAT file to disk, then
  71.         boot SPITFIRE using your SF.BAT file.  At the "SPITFIRE ready for..."
  72.         prompt, log on locally either using the ALT+S or ALT+Q keystrokes.
  73.         When you get to the Main Menu, select "<S>... SPITFIRE Doors" and your
  74.         Door Menu should appear something like this:
  75.         
  76.  
  77.         >>>>>>>> SPITFIRE DOOR MENU <<<<<<<<
  78.         <1>... Guess A Number                <2>... Unavailable to you
  79.         <3>... Unavailable to you            <4>... Unavailable to you     
  80.         <5>... Unavailable to you            <6>... Unavailable to you     
  81.         <7>... Unavailable to you            <8>... Unavailable to you     
  82.         <Q>... Quit                          <G>... Goodbye
  83.         
  84.         DOOR MENU - [1 2 3 4 5 6 7 8 Q G]?
  85.         
  86.              If you select <1> at this point, you will see a message 
  87.         SPITFIRE displays that states "Executing SPITFIRE Door 1...  Please
  88.         stand by!".  At this point, SPITFIRE writes a read-only text file to
  89.         drive named SFDOORS.DAT and then terminates, sending the appropriate
  90.         ERROR CODE to your SF.BAT file.  In the case of door #1, SPITFIRE sends
  91.         an ERROR CODE of 34 to SF.BAT which will cause the command(s) you have
  92.         placed between :DOOR_1 and GOTO LOOP to be executed.  In the event you
  93.         entered the correct commands between :DOOR_1 and GOTO LOOP, you will
  94.         then see SFGUESS run.  When you finish running SFGUESS, you will see
  95.         SPITFIRE reboot and you will be prompted for your password.
  96.  
  97.  
  98.  
  99.         SFGUESS SET UP PROCEDURE AS A SYSOP CONFIGURABLE COMMAND
  100.         --------------------------------------------------------
  101.  
  102.         SPITFIRE has a sysop configurable command for the Main, Message and
  103.         File menus.  The sysop configurable command is executed through a
  104.         batch file which corresponds to the menu it is being run from.  In
  105.         other words, SFMAIN.BAT runs the sysop configurable command from
  106.         the Main Menu, SFMESS.BAT runs the one from the Message Menu and
  107.         SFFILE.BAT the one from the File Menu.  The commands necessary
  108.         to execute SFGUESS can be set up in the batch file which corresponds
  109.         to the menu you wish to have SFGUESS run from.
  110.  
  111.         The first thing you will need to establish is which of these menus
  112.         you wish to use to run SFGUESS.  For this purpose, let's assume that
  113.         it is going to be set up so it can be run from the Main Menu.  (It
  114.         should be noted the set up procedure is the same regardless of which
  115.         Menu you are running SFGUESS from.)
  116.  
  117.         Next, you will need to decide what you wish to name the command
  118.         option and establish what security level will be required for
  119.         users of your system to be able to access this option.  Once this
  120.         is determined you will need to modify the SFMAIN.MNU file using
  121.         your favorite text editor, as long as it saves in ASCII format.
  122.         (Refer to the SPITFIRE manual for further documentation on this
  123.         if needed.  It should also be noted that if SFGUESS were being
  124.         set up to run from the File Menu, you would need to modify the
  125.         SFFILE.MNU file and if it was being set up to be run from the
  126.         Message Menu you would need to modify the SFMSG.MNU file.)
  127.  
  128.  
  129.         Examining the default SFMAIN.MNU file, you will notice the sysop
  130.         configurable command appears as:
  131.  
  132.         <K>............. Add Your Own,,1000,@
  133.  
  134.        Let's suppose that you wish to name the option to "Kan You Guess The
  135.        Number?" with a security level of 10 required to access this feature.
  136.        You would then need to modify the SFMAIN.MNU file so that it would
  137.        appear as such:
  138.  
  139.        <K>. Kan You Guess The Number?,,10,@
  140.  
  141.        Now you will need to modify the corresponding batch file, SFMAIN.BAT,
  142.        so that it can be executed from the Main Menu.  Do this using your
  143.        favorite text editor, as long as it saves in ASCII format.  (Again, it
  144.        should be noted that if SFGUESS were being set up to run from the File
  145.        Menu, you would need to modify the SFFILE.BAT file and if it was being
  146.        set up to be run from the Message Menu you would need to modify the
  147.        SFMESS.BAT file.)
  148.  
  149.        Place the SFGUESS.EXE file in the directory you wish to run the
  150.        program from.  SFGUESS will create its own player score file,
  151.        SFGUESS.TOP, if does not already exist.
  152.  
  153.        The commands set up in the SFMAIN.BAT file are very similar to
  154.        those used for executing the game through a door in the SF.BAT file.
  155.        For instance, if you were running SFGUESS from the main SPITFIRE
  156.        directory your SFMAIN.BAT file might look like this:
  157.  
  158.        ECHO OFF
  159.        BRK OFF
  160.        SFGUESS
  161.        BRK ON
  162.  
  163.        (BRK is not included in the SPITFIRE package because it is written
  164.        and copyrighted by Solid Systems, 1985, but can be downloaded from
  165.        Buffalo Creek's BBS as well as a number of other BBS systems.  BRK
  166.        is not required to run SFGUESS, however, it is recommended since it
  167.        will prevent a user using the CTRL BRK command to terminate the
  168.        batch file gaining access to your system at the DOS level.)
  169.  
  170.        If you wish to set SFGUESS up in a separate subdirectory from
  171.        SPITFIRE, for instance, a subdirectory named SFGUESS, your batch
  172.        file might look like this.
  173.  
  174.        ECHO OFF
  175.        BRK OFF
  176.        COPY SFMAIN.DAT \SF\SFGUESS
  177.        CD \SF\SFGUESS
  178.        SFGUESS
  179.        ERASE SFMAIN.DAT
  180.        CD \SF
  181.        BRK ON
  182.  
  183.  
  184.        When SFGUESS is executed, from either the door with the SF.BAT file
  185.        or from the sysop configurable command through a menu with the
  186.        corresponding batch file, it will first look for the SFMAIN.DAT file,
  187.        then the SFMESS.DAT file, then the SFFILE.DAT file and lastly the
  188.        SFDOORS.DAT file.  It will look for each of these files until it finds
  189.        it and the commands required for its execution.  If none of these
  190.        files are found, SFGUESS will halt its execution.
  191.  
  192.  
  193.        DTE LOCK
  194.        --------
  195.  
  196.        SFGUESS automatically detects if the DTE is locked at 19200 baud.  If
  197.        SFGUESS detects that the DTE is locked, then SFGUESS opens the serial
  198.        port to the maximum baud rate of your system.  If SFGUESS does not 
  199.        detect that the DTE is locked, then the serial port is opened to the
  200.        baud rate of the caller.
  201.  
  202.        SFGUESS GAME PLAY
  203.        -----------------
  204.         
  205.             SFGUESS randomly selects a number between 0 and 1000.  The object
  206.        of the game is to guess the number which has been selected in the
  207.        fewest number of guesses.  There is no limit to the number of guess
  208.        the player is allowed.  However, SFGUESS does limit the player to
  209.        30 seconds to guess the correct number before it times out.
  210.         
  211.              After the player has correctly guessed the number or the 30
  212.        second time limit has elapsed,  SFGUESS will prompt the player with
  213.        the message:
  214.         
  215.        Play another? [y/n]
  216.         
  217.        If the player respond with a "y" for yes, another number is selected
  218.        and game play continues.  If the player selects "n" for no, the game
  219.        is terminated and the player is returned to the BBS.
  220.  
  221.  
  222.        **NOTE**
  223.         
  224.             SFGUESS can also be played outside of SPITFIRE from the DOS
  225.        prompt by entering the following command line parameters:
  226.  
  227.        C:>SFGUESS /L
  228.         
  229.        This will allow the game to played in the same method as described
  230.        above except that when the player is prompted with the "Play another"
  231.        option, selecting "n" will return the player to the DOS prompt.
  232.  
  233.  
  234.        FUNCTION KEYS
  235.        -------------
  236.  
  237.        Shift F1 - Forces the caller back to SPITFIRE.
  238.  
  239.        Shift F9 - Logs callers off.
  240.         
  241.         
  242.        TOP TEN LISTING
  243.        ---------------
  244.         
  245.            SFGUESS will automatically create a Top Ten Listing of the players
  246.        who have successfully guessed the correct number in the 30 seconds
  247.        allowed.  It should be noted that only the last guess for that round
  248.        of play will be entered into the Top Ten Listing.  For instance, if a
  249.        player plays 3 rounds and successfully guessed the correct number in
  250.        10 tries the first round, 8 tries the second round and 9 tries the
  251.        last round, the last round with the 9 tries will be what is posted
  252.        to the Top Ten Listing.
  253.         
  254.         
  255.        SFGUESS ON A MULTI-NODE SYSTEM
  256.        ------------------------------
  257.    
  258.           SFGUESS is fully compatible for operation on a multi-node BBS.
  259.        It automatically handles any file locking and file sharing 
  260.        required during the doors execution.   
  261.  
  262.  
  263.        DISTRIBUTION
  264.        ------------
  265.         
  266.             SFGUESS will be distributed within the SPITFIRE Bulletin Board
  267.        System package.  It can also be distributed independently.  The only
  268.        requirement being that it must remain in unmodified form.
  269.         
  270.             SFGUESS is distributed under the Shareware concept.  You are
  271.        free to try SFGUESS for a 10 days, but if you should decide to
  272.        continue using SFGUESS registration is mandatory.  The registration
  273.        fee to unregistered SPITFIRE Sysops is $5.00 and to those who have
  274.        registered SPITFIRE it is $1.00.
  275.  
  276.         DISCLAIMER
  277.         ----------
  278.          
  279.              Mike Woltz and Buffalo Creek Software shall not be held
  280.         responsible for any damage incurred by the user to hardware,
  281.         software or other peripheral devices will running SFGUESS.  All
  282.         responsibility lies with the user of the software.
  283.  
  284.          
  285.               SFGUESS, SPITFIRE and other SPITFIRE related programs can be
  286.         downloaded from:
  287.          
  288.                             Buffalo Creek's BBS
  289.                             Sysop - Mike Woltz
  290.                                515-225-8496
  291.                          38400,19200,9600,2400,1200
  292.                                   2 Nodes
  293.